Payments Page Integration – Implementation

3.12 Refund API (Optional)

Merchant who want to refund a transaction that has been settled by the payment gateway.
Calling the endpoint with the required data will trigger a refund request with the relevant bank.
(by issuing a 220 instruction).
The endpoint requires Basic Auth (See Appendix I).

Table 25. Refund API endpoints
URL Type	URL Value
Test (QA) Post Page	https://qa.vodacompaymentgateway.co.za/api/pay/refund
Live (PROD) Post Page	https://psp.vodacompaymentgateway.co.za/api/pay/refund

3.12.1. Request

Table 26. Refund API endpoint request payload
Field Name (Case–Sensitive)	Type	Required Mandatory Optional	Description
TransactionId	String	M	Trassmart transaction id for the original transaction settled in Transsmart.
Amount	String	M	The Amount that is needed to be refunded. A transaction can be refunded multiple times up until the full amount of the original transaction.
IsRecurring	String	M	A flag indicating of the original transaction was a recurring transaction or a once off..
MerchantCustomerReference	String	O	A unique value representing the merchant's customer undertaking this tokenisation (.referred to as CustomerIdentifier in the transaction object).
MerchantTokenReference	Numeric	O	The merchanttokenreference provided by the merchant as part of the phase 1 tokenization request. If this field is not passed it will be set to merchantcustomerreference above.
MerchantId	String	M	Unique identifier issues to the merchant by payment gateway .

3.12.2. Response

The response of the API request will indicate 200(Ok) on successful refund request. If the request fails either a 400(Bad request) or 401(Unauthorized) will be returned depending on the cause of the error. s

Continue

Continue to 3.13 Cancel Pre-Auth API (Optional)

Return

Return to 3.11 Delete Saved Card (Optional)
Return to 3. Implementation Steps
Return to 1. Contents